/*
 * Package il.ac.biu.cs.grossmm.api.data
 * File PropertyByInterface.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package il.ac.biu.cs.grossmm.api.data;

/**
 * Represents a property within a node type as defined by a property constant in
 * a node type interface
 * 
 * <p>
 * Instances of this class are created using
 * {@link NodeTypeByInterface#property(Class, Class)} method
 * 
 * @see NodeInterface
 * 
 * @author Mark Grossmann
 */
public class PropertyByInterface<N, V> implements Property<N, V> {
	private boolean initialized = false;

	private int index;

	private NodeType<N> parentNodeType;

	private final Class<N> nClass;

	private final Class<V> vClass;
	
	private String name;

	PropertyByInterface(Class<N> nClass, Class<V> vClass)
	{
		this.index = -1;
		this.nClass = nClass;
		this.vClass = vClass;
	}

	void initialize(int index, String name, NodeType<N> parentNodeType)
	{
		this.index = index;
		this.name = name;
		this.parentNodeType = parentNodeType;
		initialized = true;
	}

	public final int index()
	{
		if( !initialized ) // optimization.
			ensureInit();

		return index;
	}

	private final void ensureInit()
	{
		if (!initialized)
			NodeTypeByInterface.initialize(nClass);
	}

	public NodeType<N> getParentNodeType()
	{
		if( !initialized ) // optimization.
			ensureInit();

		return parentNodeType;
	}

	public Class<V> getValueClass()
	{
		return vClass;
	}

	/**
	 * Returns a Class object of node type interface which defines this property
	 * 
	 * @return a Class object of node type interface which defines this property
	 */
	public Class<N> getDeclaringInterface()
	{
		return nClass;
	}

	public boolean isUnique()
	{
		return false;
	}
	
	@Override
	public String toString() {
		return name;
	}
}
